Bulk Detach Subscriber Offer

This API is used to detach Regular or Pool plans from multiple subscribers in a single call.

The deletion is soft, but once executed, it cannot be recovered.

HTTP URL

 
DELETE /api/v2/bulk/subscriber/offer

Eligibility

The Requester is eligible to detach a plan from sub-customers’ subscribers.

The Requester is eligible to detach a Buy Plan from own subscribers only if the Parent account sets the allowOfferDelegation parameter to True for the Requester’s account.

API Request

Request Structure

Parameter

Type

M/O/CM

Description

bulk

Object

M

Array of main request body object.

Bulk data objects

Element

Type

M/O/CM

Description

subscriberIdentifiers

Object

M

Subscriber unique keys object, defines the search criteria

content

Object

M

Main elements container object

subscriberidentifiers data objects

Element

Type

M/O/CM

Description

type

String

M

Define the search criteria.

ENUMs: IMSI, ICCID, MSISDN, IMEI

value

String

M

Type value. IMSI or ICCID or MSISDN or IMEI number.

Content data objects

Parameter

Type

M/O/CM

Description

subscriberOfferingId

UUID

M

Subscriber offer ID

myOffer

Boolean

O

Determines whether to:

Detach one of my Customer plans (Sell Plan offers) from my sub accounts’ subscribers

OR

Detach one of the Parent’s Buy Plans from my accounts’ subscribers.

[myOffer] True = Request to detach a Parent plan (Buy Plan offer) from my own subscribers. This self-service functionality is allowed only when the sub-customer was defined by my Parent as authorized for delegation of Parent Plans [allow_offer_delegation = true].

[myOffer] False = Request to detach one of my Customer plans (Sell Plan offers) from my sub accounts subscribers (Normal operation)

Default (if not provided) = False

API Response

Response Structure

Parameter

Type

M/O/CM

Description

bulk

Object

M

Array of main response body object.

pageable

Object

O

Paging information object displayed when an API call was successful. For a failure, it will be empty.

Bulk data objects

Parameter

Type

M/O/CM

Description

errorCode

String

O

Failure code.

errorMessage

String

O

Failure message.

requestId

UUID

CM

Request instance ID.

To be used by external systems to query the call (operation) status:

In progress

Successful

Failed.

Displayed when an API call was successful. For a failure, it will be empty.

subscriberIdentifiers

Object

M

Subscriber unique keys object, defines the search criteria

content

Object

O

Main response body object that reflects a single node of the original request.

subscriberidentifiers data objects

Parameter

Type

M/O/CM

Description

type

String

M

Define the search criteria.

ENUMs: IMSI, ICCID, MSISDN, IMEI

value

String

M

Type value. IMSI or ICCID or MSISDN or IMEI number.

Content data objects

Element

Type

M/O/CM

Description

subscriberOfferingId

UUID

M

Subscriber offer ID

myOffer

Boolean

M

Determines whether to:

Attach one of my Customer plans (Sell Plan offers) to my sub accounts’ subscribers

OR

Attach one of the Parent’s Buy Plans to my accounts’ subscribers.

[myOffer] True = Request to attach a Parent plan (Buy Plan offer) to my own subscribers.

[myOffer] False = Request to attach one of my Customer plans (Sell Plan offers) to my sub accounts subscribers (Normal operation)

Default if not provided is ‘false’

Pageable data objects

Element

Type

M/O/CM

Description

page

Numeric

M

Page number

size

Numeric

M

Page size. Number of requested elements per page

totalPages

Numeric

M

Total amount of available pages per requested page size

totalElements

Numeric

M

Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code

Message

GLOBAL_1001

Service unavailable. Please try again

SUBSCRIBER_1011

Failed to detach offer

AUTH_1013

You are not allowed to detach parent customer plans from your own SIM cards

Examples

Request Body

Copy 
{
  "bulk": [
    {
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961859"
      },
      "content": {
        "subscriberOfferingId": "4543dedb-cce7-4bee-89f3-7af1447927e6"
      }
    },
    {
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000034535"
      },
      "content": {
        "subscriberOfferingId": "e7fcef24-5c03-41dd-9e33-995b7d6f47e2",
        "myOffer": true
      }
    }
  ]
}

Response Body: Full Success ACK

Copy 
{
  "bulk": [
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961963"
      },
      "content": {
        "subscriberOfferingId": "4543dedb-cce7-4bee-89f3-7af1447927e6",
        "myOffer": false
      }
    },
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "7e74dce6-8eef-4c86-a4bb-1a860913c271",
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000035687"
      },
      "content": {
        "subscriberOfferingId": "e7fcef24-5c03-41dd-9e33-995b7d6f47e2",
        "myOffer": true
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Includes Failure(s) (NAK)

Copy 
{
  "bulk": [
    {
      "errorCode": "AUTH_1013",
      "errorMessage": "You are not allowed to detach parent customer plans from your own SIM card",
      "requestId": "",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961963"
      },
      "content": {
        "subscriberOfferingId": "4543dedb-cce7-4bee-89f3-7af1447927e6",
        "myOffer": false
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}